
<!DOCTYPE html>
<!--

    Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->
<!-- Portions Copyright [2019] [Payara Foundation and/or its affiliates] -->
<html lang="en">
  <head>
    <meta charset="utf-8"/>
    <title>setup-local-dcom</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link href="css/style.css" rel="stylesheet">
    <script src="https://use.fontawesome.com/96c4d89611.js"></script>
  </head>
  <body>
<table id="doc-title" cellspacing="0" cellpadding="0">
  <tr>
  <td align="left" valign="top">
  <b>setup-local-dcom</b><br />
  </td>
  </tr>
</table>
<hr />

<table width="90%" id="top-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>
		<td align="left">
		<a href="set-log-levels.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="setup-ssh.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class=" vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>


<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p><a id="setup-local-dcom-1"></a><a id="GSRFM893"></a><a id="setup-local-dcom"></a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_setup_local_dcom">setup-local-dcom</h2>
<div class="sectionbody">
<div class="paragraph">
<p>sets up DCOM on a host</p>
</div>
<div id="sthref2066" class="paragraph">
<p>Synopsis</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin [asadmin-options] setup-local-dcom [--help]
[--verbose={false|true}]
--force={false|true}</code></pre>
</div>
</div>
<div id="sthref2067" class="paragraph">
<p>Description</p>
</div>
<div class="paragraph">
<p>The <code>setup-local-dcom</code> subcommand sets up the Distributed Component
Object Model (DCOM) remote protocol on the host where the subcommand is
run. The DCOM remote protocol is available only on Windows systems.</p>
</div>
<div class="paragraph">
<p>This subcommand must be run by the operating-system-level administrator
user on the host where DCOM is being set up.</p>
</div>
<div class="paragraph">
<p>Setting up DCOM on a host ensures that scripts can be run on the host
from a remote host. To run scripts on the host from a remote host, the
Windows user must be allowed full control over some Windows registry
keys.</p>
</div>
<div class="paragraph">
<p>In some versions of Windows, only the user <code>NT SERVICE\TrustedInstaller</code>
has full control over these Windows registry keys. If the version of
Windows on a host is configured in this way, this subcommand modifies
these keys to allow full control over them for the Windows user.</p>
</div>
<div class="admonitionblock caution">
<table>
<tr>
<td class="icon">
<div class="title">Caution</div>
</td>
<td class="content">
<div class="paragraph">
<p>This subcommand might modify the permissions of some keys in the Windows
registry. Before running this command, back up the Windows registry.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>By default, the subcommand prompts you to confirm that you want to
update the Windows registry. To run the subcommand without being
prompted, set the <code>--force</code> option to <code>true</code>.</p>
</div>
<div class="paragraph">
<p>This subcommand is supported in local mode only.</p>
</div>
<div id="sthref2068" class="paragraph">
<p>Options</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">asadmin-options</dt>
<dd>
<p>Options for the <code>asadmin</code> utility. For information about these
options, see the <a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a> help page.</p>
</dd>
<dt class="hdlist1"><code>--help</code></dt>
<dt class="hdlist1"><code>-?</code></dt>
<dd>
<p>Displays the help text for the subcommand.</p>
</dd>
<dt class="hdlist1"><code>--verbose</code></dt>
<dt class="hdlist1"><code>-v</code></dt>
<dd>
<p>Specifies whether the subcommand displays information about the
operations that are performed to set up DCOM on the host.<br>
Possible values are as follows:<br></p>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>false</code></dt>
<dd>
<p>No information about the operations that are performed to set up
DCOM is displayed (default).</p>
</dd>
<dt class="hdlist1"><code>true</code></dt>
<dd>
<p>The subcommand displays information about the operations that are
performed to set up DCOM on the host.</p>
</dd>
</dl>
</div>
</dd>
<dt class="hdlist1"><code>--force</code></dt>
<dt class="hdlist1"><code>-f</code></dt>
<dd>
<p>Specifies whether the subcommand prompts you to confirm that you want
to update the Windows registry.<br>
Possible values are as follows:<br></p>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>false</code></dt>
<dd>
<p>You are prompted to confirm that you want to update the Windows
registry (default).</p>
</dd>
<dt class="hdlist1"><code>true</code></dt>
<dd>
<p>The subcommand forcibly updates the Windows registry without
prompting you.</p>
</dd>
</dl>
</div>
</dd>
</dl>
</div>
<div id="sthref2069" class="paragraph">
<p>Examples</p>
</div>
<div class="paragraph">
<p><a id="GSRFM737"></a><a id="sthref2070"></a></p>
</div>
<div class="paragraph">
<p>Example 1   Setting Up DCOM on a Host</p>
</div>
<div class="paragraph">
<p>This example sets up DCOM on the host where the subcommand is run.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin&gt; setup-local-dcom
Caution: This command might modify the permissions of some keys in the Windows
registry.
Before running this command, back up the Windows registry.
The modification allows the Windows user full control over these keys.

Are you sure that you want to edit the Windows registry? If so, type yes in full: yes
Command setup-local-dcom executed successfully.</code></pre>
</div>
</div>
<div class="paragraph">
<p><a id="GSRFM894"></a><a id="sthref2071"></a></p>
</div>
<div class="paragraph">
<p>Example 2   Forcibly Setting Up DCOM on a Host</p>
</div>
<div class="paragraph">
<p>This example sets up DCOM without prompting for confirmation that the
user wants to update the Windows registry.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin&gt; setup-local-dcom --force=true
Command setup-local-dcom executed successfully.</code></pre>
</div>
</div>
<div id="sthref2072" class="paragraph">
<p>Exit Status</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">0</dt>
<dd>
<p>command executed successfully</p>
</dd>
<dt class="hdlist1">1</dt>
<dd>
<p>error in executing the command</p>
</dd>
</dl>
</div>
<div id="sthref2073" class="paragraph">
<p>See Also</p>
</div>
<div class="paragraph">
<p><a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a></p>
</div>
</div>
</div>

<hr />

<table width="90%" id="bottom-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>		
		<td align="left">
		<a href="set-log-levels.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="setup-ssh.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class="vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>

<span id="copyright">
        <img src="/resource/reference/img/eclipse_foundation_logo_tiny.png" height="20px" alt="Eclipse Foundation Logo" align="top"/>&nbsp;            
        <span >Copyright&nbsp;&copy;&nbsp;2019,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span>
</span>

</body>
</html>
